<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PopplerLayer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Poppler Reference Manual">
<link rel="up" href="ch01.html" title="Poppler">
<link rel="prev" href="PopplerAnnot.html" title="PopplerAnnot">
<link rel="next" href="PopplerMedia.html" title="PopplerMedia">
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="PopplerAnnot.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Poppler Reference Manual</th>
<td><a accesskey="n" href="PopplerMedia.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#PopplerLayer.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#PopplerLayer.description" class="shortcut">Description</a>
                   | 
                  <a href="#PopplerLayer.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="PopplerLayer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PopplerLayer.top_of_page"></a>PopplerLayer</span></h2>
<p>PopplerLayer — Layers</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="PopplerLayer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;poppler.h&gt;

                    <a class="link" href="PopplerLayer.html#PopplerLayer-struct" title="PopplerLayer">PopplerLayer</a>;
const <span class="returnvalue">gchar</span> *       <a class="link" href="PopplerLayer.html#poppler-layer-get-title" title="poppler_layer_get_title ()">poppler_layer_get_title</a>             (<em class="parameter"><code><a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a> *layer</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="PopplerLayer.html#poppler-layer-is-visible" title="poppler_layer_is_visible ()">poppler_layer_is_visible</a>            (<em class="parameter"><code><a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a> *layer</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="PopplerLayer.html#poppler-layer-show" title="poppler_layer_show ()">poppler_layer_show</a>                  (<em class="parameter"><code><a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a> *layer</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="PopplerLayer.html#poppler-layer-hide" title="poppler_layer_hide ()">poppler_layer_hide</a>                  (<em class="parameter"><code><a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a> *layer</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="PopplerLayer.html#poppler-layer-is-parent" title="poppler_layer_is_parent ()">poppler_layer_is_parent</a>             (<em class="parameter"><code><a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a> *layer</code></em>);
<span class="returnvalue">gint</span>                <a class="link" href="PopplerLayer.html#poppler-layer-get-radio-button-group-id" title="poppler_layer_get_radio_button_group_id ()">poppler_layer_get_radio_button_group_id</a>
                                                        (<em class="parameter"><code><a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a> *layer</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="PopplerLayer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----PopplerLayer
</pre>
</div>
<div class="refsect1">
<a name="PopplerLayer.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="PopplerLayer.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="PopplerLayer-struct"></a><h3>PopplerLayer</h3>
<pre class="programlisting">typedef struct _PopplerLayer PopplerLayer;</pre>
</div>
<hr>
<div class="refsect2">
<a name="poppler-layer-get-title"></a><h3>poppler_layer_get_title ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       poppler_layer_get_title             (<em class="parameter"><code><a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a> *layer</code></em>);</pre>
<p>
Returns the name of the layer suitable for
presentation as a title in a viewer's GUI
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer</code></em> :</span></p></td>
<td>a <a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a string containing the title of the layer</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.12</p>
</div>
<hr>
<div class="refsect2">
<a name="poppler-layer-is-visible"></a><h3>poppler_layer_is_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            poppler_layer_is_visible            (<em class="parameter"><code><a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a> *layer</code></em>);</pre>
<p>
Returns whether <em class="parameter"><code>layer</code></em> is visible
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer</code></em> :</span></p></td>
<td>a <a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if <em class="parameter"><code>layer</code></em> is visible</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.12</p>
</div>
<hr>
<div class="refsect2">
<a name="poppler-layer-show"></a><h3>poppler_layer_show ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                poppler_layer_show                  (<em class="parameter"><code><a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a> *layer</code></em>);</pre>
<p>
Shows <em class="parameter"><code>layer</code></em>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>layer</code></em> :</span></p></td>
<td>a <a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.12</p>
</div>
<hr>
<div class="refsect2">
<a name="poppler-layer-hide"></a><h3>poppler_layer_hide ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                poppler_layer_hide                  (<em class="parameter"><code><a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a> *layer</code></em>);</pre>
<p>
Hides <em class="parameter"><code>layer</code></em>. If <em class="parameter"><code>layer</code></em> is the parent of other nested layers,
such layers will be also hidden and will be blocked until <em class="parameter"><code>layer</code></em>
is shown again
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>layer</code></em> :</span></p></td>
<td>a <a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.12</p>
</div>
<hr>
<div class="refsect2">
<a name="poppler-layer-is-parent"></a><h3>poppler_layer_is_parent ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            poppler_layer_is_parent             (<em class="parameter"><code><a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a> *layer</code></em>);</pre>
<p>
Returns whether <em class="parameter"><code>layer</code></em> is parent of other nested layers.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer</code></em> :</span></p></td>
<td>a <a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if <em class="parameter"><code>layer</code></em> is a parent layer</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.12</p>
</div>
<hr>
<div class="refsect2">
<a name="poppler-layer-get-radio-button-group-id"></a><h3>poppler_layer_get_radio_button_group_id ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>                poppler_layer_get_radio_button_group_id
                                                        (<em class="parameter"><code><a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a> *layer</code></em>);</pre>
<p>
Returns the numeric ID the radio button group associated with <em class="parameter"><code>layer</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>layer</code></em> :</span></p></td>
<td>a <a class="link" href="PopplerLayer.html" title="PopplerLayer"><span class="type">PopplerLayer</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the ID of the radio button group associated with <em class="parameter"><code>layer</code></em>,
or 0 if the layer is not associated to any radio button group</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.12</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.17</div>
</body>
</html>